<HTML><HEAD><TITLE>icompile(+File)</TITLE>
</HEAD><BODY>[ <A HREF="index.html">library(document)</A> | <A HREF="../../index.html">Reference Manual</A> | <A HREF="../../fullindex.html">Alphabetic Index</A> ]
<H1>icompile(+File)</H1>
Generates an information file from the ECLiPSe source File.
<DL>
<DT><EM>File</EM></DT>
<DD>Name of source file (Atom or string)
</DD>
</DL>
<H2>Description</H2>

    Given an ECLiPSe source file (usually a file with a .ecl suffix), this
    tool generates an ECLiPSe interface information file (with .eci suffix).
    The output file is created in the same directory as the source file.
    To create it elsewhere, use icompile/2.
    <P>
    The given source file must contain a module definition. icompile then
    extracts all information about this module's interface (in particular
    all export directives), as well as the corresponding documentation
    (comment/2) directives, and writes those into an interface information
    file with .eci suffix. The latter can then be used to generate HTML
    documentation about the module.
    
<H3>Modules</H3>
This predicate is sensitive to its module context (tool predicate, see @/2).
<H2>See Also</H2>
<A HREF="../../lib/document/icompile-2.html">icompile / 2</A>, <A HREF="../../kernel/directives/comment-2.html">comment / 2</A>, <A HREF="../../lib/document/eci_to_html-3.html">eci_to_html / 3</A>, <A HREF="../../lib/document/ecis_to_htmls-4.html">ecis_to_htmls / 4</A>
</BODY></HTML>
